Skip to main content

Maven Integration API

Cost New provides an API which allow data to be pushed from Maven. To ease security concerns the link between Maven and Cost New is push only. This means that every time data is added to Maven it must be manually pushed by clicking the send button before it will appear on Cost New.

Required Information​

Configuring Maven to push data to Cost New will require a read/write API token. The token can be entered into Maven along with the endpoints to configure Maven.

To obtain the appropriate token contact AgWare support.

Supported Data​

Cost New supports the following types.

  • Improvement type
  • Quality type
  • Region type
  • Area type
  • Zone type

There are additional endpoints for improvement kind, condition type, unit type, and utility type, however, these are not currently used by Cost New.

Endpoints​

Cost New uses the following endpoints for Maven pushes.

  • <tenant name>/api/improvementtype
  • <tenant name>/api/improvementkind
  • <tenant name>/api/qualitytype
  • <tenant name>/api/conditiontype
  • <tenant name>/api/unittype
  • <tenant name>/api/utilitytype
  • <tenant name>/api/regiontype
  • <tenant name>/api/areatype
  • <tenant name>/api/zonetype

Data Processing​

Approved entries sent from Maven are processed as follows.

If an entry with the same name does not exist on Cost New then it is created and assigned the DataLog Data Source Class. The new entry is also linked to the Maven entry.

If an entry with a matching name does exist then the entry's Data Source Class is updated to DataLog and the item is linked to the Maven entry.

If an entry is linked to an existing Maven entry then the name is updated to match the current Maven entry.

If an entry is linked to a Maven entry that has been deleted then the Data Source Class is updated to Cost New.

All other entries on Cost New are not affected by the push process.

Data Source Class​

The Data Source Class is a field on most setup data that indicates where the entry originates from, and what about the entry the user can edit. The Data Source Class is controlled by the system and will only be updated during pushes from Maven as described above in the data processing section.

Entries with the DataLog Data Source Class only allow the user to edit the visibility of the entry in drop down menu. The name and other fields cannot be changed.

Entries with the Cost New Data Source Class allow all fields except the Data Source Class to be changed.